Clientes API
Introducción
El Cliente API del IXC ACS permite integrar la plataforma a sistemas externos, como ERPs, viabilizando automaciones y el intercambio de información.
Además de la integración genérica, también hay una integración específica con el IXC Defensor, dirigida a los flujos más comunes, permitiendo el envío de datos como PPPoE y informaciones de Wi-Fi.
Después del registro y la finalización de la integración, la comunicación entre los sistemas ocurre de forma automática.
¿Qué es un cliente API?API (Interface de programación de aplicaciones) es un conjunto de reglas que permite que los sistemas se comuniquen de forma automática. En el IXC ACS, el Cliente API representa esta “puente” de comunicación entre el ACS y otros sistemas, como ERPs, plataformas externas o el propio IXC Defensor.
Para la integración con el IXC Defensor, es importante destacar que el registro del Cliente API en el IXC ACS es sólo la primera etapa del proceso. Otras configuraciones son necesarias para que la integración funcione correctamente.
Caminho: Menú Herramientas > Cliente API > Nuevo Cliente API
Preferencias
Al acceder a la opción Novo Cliente API, se mostrará un modal de configuración en el que se define como IXC ACS se comunicará con otro sistema.
Tipos de integración del cliente API
En esta etapa, usted define con cuál sistema el ACS se integrará. Actualmente existen dos tipos de integración disponibles:
1. Genérica
Utilizada cuando IXC ACS se integra a sistemas de terceros (excepto IXC Defensor), como ERPs o plataformas externas. En este modelo, el sistema externo será responsable de consumir la API de ACS y recibir los webhooks configurados.
- Antes del paso a paso, vea abajo los campos utilizados en la creación del Cliente API genérico:*
| Campo | Descripción |
|---|---|
| Nombre | Identificación del cliente API |
| Expiración del token | Tiempo de validez del token en segundos. Después de ese período, será necesario generar un nuevo token para continuar utilizando la API |
| Requisiciones por minuto | Límite de llamadas a la API permitidas por minuto |
| Requisiciones al día | Límite de llamadas a la API permitidas por día |
| Webhook URL | Dirección del sistema externo que recibirá las notificaciones de ACS |
| Certificado no válido | Define si ACS aceptará enviar webhooks a una URL con certificado SSL no válido |
| Webhooks emitidos | |
| Los webhooks representan eventos que ACS envía automáticamente al sistema externo cuando algo sucede. Ejemplos: | |
| • dispositivo añadido o eliminado | |
| • cambio de parámetros del dispositivo | |
| • reset o reboot | |
| • finalización de diagnóstico |
si se solicita un reboot vía API, cuando el dispositivo reinicia, ACS enviará un webhook notificando el sistema externo. El mismo concepto se aplica a los demás eventos.
Seleccione sólo los eventos necesarios ayuda a reducir el tráfico y hacer que la integración sea más eficiente.
Preferencias de la integración del cliente API genérica
En la modal Crear cliente API, seleccione el tipo Genérica
Rellene el nombre de identificación
Establecer el tiempo de expiración del token
Configure los límites de requisiciones por minuto y por día
Activa la webhook e informe la URL del sistema externo • Si la URL utiliza un certificado SSL no válido, habilite la opción Certificado no válido
Seleccione los webhooks que serán emitidos
Haga clic en Crear cliente API
Después de la creación, es posible editar el Cliente API y definir sus permisiones. Para ello, haga clic en los tres puntos a la derecha del cliente creado y ajuste qué recursos de la API puede acceder.
2. IXC Defensor
La integración con IXC El Defensor exige configuraciones en el IXC ACS y en el IXC Defensor, realizadas conjuntamente.
No IXC ACS
En la modal Crear cliente API, seleccione el tipo IXC Defensor
En Nome, informe algo que identifique claramente la integración, por ejemplo: Integración IXC Defensor
En el campo Chave pública, será necesario pegar la clave que se generará en el IXC Defensor (ver los pasos abajo)
En el IXC Defensor
Visita Menu Sistema > Defensor > ACS > Integraciones
Haga clic en Novo
Seleccione la opción IXC ACS
En nombre, informe a un identificador de ACS
Deje el campo Usuario API en blanco en este momento
Informe el dominio del servidor ACS (utilizando http)
Haga clic en Salvar
La clave pública se generará. Copie esa llave
Regresando al IXC ACS
Cole la clave pública en el campo correspondiente
En el campo Webhook URI, informe el dominio del proveedor seguido de
/api-module/acs/webhookEjemplo:http://seuprovedor/api-module/acs/webhook6. Si el certificado SSL no es válido, habilite Certificado no válidoHaga clic en Crear cliente API
Copie el ID del cliente API generado
Finalizando en el IXC Defensor
Edite la integración creada
En el campo Usuario API, cole el ID del Cliente API
Guardar configuración
Con esta etapa concluida, podrá seguir para las próximas configuraciones de la integración entre el IXC ACS y el IXC Defensor. .
Integração do IXC ACS com o IXC Provedor via API en la Central de Ayuda.
A diferencia del token, la clave pública no expira rápidamente y es utilizada para identificar el sistema socio durante la integración.
Glosario
| Termo | Descripción |
|---|---|
| Token | Chave de autenticación temporal utilizada para acceder a la API |
| ERP | Sistema de gestión empresarial |
| Requisición | Cada llamada hecha a la API para enviar o consultar información |
| Webhook | Notificación automática enviada del ACS a otro sistema cuando un evento ocurre |
| Webhook URI | Enderezo que recibirá las notificaciones de ACS |
| Certificado no válido | Permite que ACS envíe webhooks incluso cuando el certificado SSL del sistema externo no es válido |
Consideraciones finales
El Cliente API es la base para cualquier integración del IXC ACS con sistemas externos o con el IXC Defensor. Al configurar correctamente esta etapa inicial, garantiza una comunicación automática, segura y eficiente entre las plataformas, preparando el ambiente para las demás configuraciones de la integración.